guppy-summaries

Facilities to serialize, deserialize and compare build summaries.

A build summary is a record of what packages and features are built on the target and host platforms. A summary file can be checked into a repository, kept up to date and compared in CI, and allow for tracking results of builds over time.

guppy-summaries is designed to be small and independent of the main guppy crate.

Usage

Add the following to your Cargo.toml:

[dependencies]
guppy-summaries = "0.1.0"

Examples

use guppy_summaries::{Summary, SummaryId, SummarySource, SummaryDiffStatus};
use pretty_assertions::assert_eq;
use semver::Version;
use std::collections::BTreeSet;

// A summary is a TOML file that has this format:
static SUMMARY: &str = r#"
[[target-initial]]
name = "foo"
version = "1.2.3"
workspace-path = "foo"
features = ["feature-a", "feature-c"]

[[host-initial]]
name = "proc-macro"
version = "0.1.2"
workspace-path = "proc-macros/macro"
features = ["macro-expand"]

[[host-package]]
name = "bar"
version = "0.4.5"
crates-io = true
features = []
"#;

// The summary can be deserialized:
let summary = Summary::from_str(SUMMARY).expect("from_str succeeded");

// ... and a package and its features can be looked up.
let summary_id = SummaryId::new("foo", Version::new(1, 2, 3), SummarySource::workspace("foo"));
let features = &summary.target_initials[&summary_id];
assert_eq!(
    &features.iter().map(|feature| feature.as_str()).collect::<Vec<_>>(),
    &["feature-a", "feature-c"],
    "correct feature list"
);

// Another summary.
static SUMMARY2: &str = r#"
[[target-initial]]
name = "foo"
version = "1.2.4"
workspace-path = "new-location/foo"
features = ["feature-a", "feature-b"]

[[target-package]]
name = "once_cell"
version = "1.4.0"
source = "git+https://github.com/matklad/once_cell?tag=v1.4.0"
features = ["std"]

[[host-package]]
name = "bar"
version = "0.4.5"
crates-io = true
features = []
"#;

let summary2 = Summary::from_str(SUMMARY2).expect("from_str succeeded");

// Diff summary and summary2.
let diff = summary.diff(&summary2);

// Pretty-print the diff.
let diff_str = format!("{}", diff);
assert_eq!(
    diff_str,
    r#"target initials:
  foo 1.2.4 (workspace path 'new-location/foo')
    * version upgraded from 1.2.3
    * source changed from workspace path 'foo'
    * added features: feature-b
    * removed features: feature-c
    * (unchanged features: feature-a)

host initials:
  proc-macro 0.1.2 (workspace path 'proc-macros/macro')
    * removed package, old features: macro-expand

target packages:
  once_cell 1.4.0 (external 'git+https://github.com/matklad/once_cell?tag=v1.4.0')
    * added package, features: std

"#
);

Contributing

See the CONTRIBUTING file for how to help out.

License

This project is available under the terms of either the Apache 2.0 license or the MIT license.